Provider Services API
Use Cases
Provider Services
Teams at Life Sciences and Health organizations, such as Sales, MSLs, and KAMs, need accurate HCP and HCO information to plan relevant customer engagement. Provider Services addresses two distinct moments in that workflow: finding a provider that isn't in CRM and correcting data for a provider that is already there.
Search Before Create (SBC)
Context
Commercial teams need a quick way to find trusted information about an HCP or HCO that isn't yet available in their CRM.
Scenario
A Cumulus Pharma user meets an HCP whose data isn't in CRM. Without an online search, the user must research the provider manually or revisit the location later.
Solution
SBC searches IQVIA OneKey in real time and lets the user download the selected HCP or HCO, with related data, into Life Sciences or Health Cloud.
Benefits
- Gives commercial teams provider information while they are planning or conducting an engagement.
- Reduces duplicate provider creation by searching a trusted source first.
- Reduces manual research and repeat visits caused by missing CRM data.
What's Supported Out of the Box
- Sources provider data from IQVIA OneKey; an active OneKey agreement is required.
- Provides synchronous search and download operations under the
provider-services/v1base path. - Downloads an Individual, Workplace, or Activity, including the related addresses, phones, specialties, business licenses, affiliations, and provider records returned for the selected entity.
- Resolves affiliations and multi-level workplace hierarchies through asynchronous post-processing after the main entity is upserted.
- Uses one generic field mapping, with per-country reference data loaded by the Provider Bulk Sync Codes Job.
Data Change Request (DCR)
Context
Commercial teams also identify inaccurate or missing information on HCP and HCO records that already exist in CRM. Those changes must be validated by the trusted data source before the mastered record is updated.
Scenario
A Cumulus Pharma user learns that an existing HCP has a new address or specialty and raises a validation request from Life Sciences Cloud.
Solution
DCR submits the requested create or update to OneKey, tracks its status, and writes the OneKey decision back to the Data Change Request record. Approved data returns to Life Sciences Cloud through the Provider Bulk Sync delta process.
Benefits
- Keeps existing HCP and HCO information aligned with OneKey.
- Gives users a traceable status for each requested correction.
- Reduces manual coordination between field teams and data stewards.
What's Supported Out of the Box
- Pushes field-level HCP and HCO validation requests to OneKey through scheduled jobs; DCR isn't an inbound API operation.
- Supports create and update operations. Delete isn't supported.
- Supports six physical Salesforce entities: Account, HealthcareProvider, HealthcareProviderSpecialty, CareSpecialty, ContactPointAddress, and ProviderAffiliation.
- Creates one primary OneKey request for a parent DCR and its linked child records. The primary request includes the first address and first affiliation; each additional address or affiliation is submitted separately. HealthcareProviderSpecialty records are included in the primary request and appended to each additional request.
- Sends every HCP-related request as
activityand every HCO-related request asworkplace, then applies the shipped US-versus-non-US mandatory-field rules before submission. - Processes Submission and Monitoring records oldest-first and requires Apply Changes Immediately as the Field Update Type.
- Submits only Hard affiliations and forwards populated parent and child DCR comments to OneKey. Salesforce DCR Handler customization is needed only when the originating process doesn't populate
LifeSciDataChangeRequest.Comments.